home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_qt.idb / usr / freeware / catman / p_man / cat3 / qlayout.Z / qlayout
Encoding:
Text File  |  1998-10-28  |  14.7 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      QQQQLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))      QQQQLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       QLayout - The    base class of geometry specifiers
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       #include <qlayout.h>
  13.  
  14.       Inherits QObject.
  15.  
  16.       Inherited by QBoxLayout and QGridLayout.
  17.  
  18.     PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrrssss
  19.       vvvviiiirrrrttttuuuuaaaallll ~~~~QQQQLLLLaaaayyyyoooouuuutttt ()
  20.       iiiinnnntttt ddddeeeeffffaaaauuuullllttttBBBBoooorrrrddddeeeerrrr (((()))) ccccoooonnnnsssstttt
  21.       eeeennnnuuuummmm {{{{ uuuunnnnlllliiiimmmmiiiitttteeeedddd ==== QQQQCCCCOOOOOOOORRRRDDDD____MMMMAAAAXXXX    }}}}
  22.       vvvviiiirrrrttttuuuuaaaallll bbbboooooooollll aaaaccccttttiiiivvvvaaaatttteeee    (((())))
  23.       vvvvooooiiiidddd ffffrrrreeeeeeeezzzzeeee ((((    iiiinnnntttt _w,,,, iiiinnnntttt hhhh ))))
  24.       vvvvooooiiiidddd ffffrrrreeeeeeeezzzzeeee (((())))
  25.       vvvvooooiiiidddd sssseeeettttMMMMeeeennnnuuuuBBBBaaaarrrr (((( QQQQMMMMeeeennnnuuuuBBBBaaaarrrr **** wwww ))))
  26.       QQQQWWWWiiiiddddggggeeeetttt**** mmmmaaaaiiiinnnnWWWWiiiiddddggggeeeetttt (((())))
  27.  
  28.     PPPPrrrrooootttteeeecccctttteeeedddd MMMMeeeemmmmbbbbeeeerrrrssss
  29.       QQQQLLLLaaaayyyyoooouuuutttt (((( QQQQWWWWiiiiddddggggeeeetttt **** _p_a_r_e_n_t,,,, iiiinnnntttt _b_o_r_d_e_r,,,, iiiinnnntttt _a_u_t_o_B_o_r_d_e_r
  30.       QQQQLLLLaaaayyyyoooouuuutttt (((( iiiinnnntttt    _a_u_t_o_B_o_r_d_e_r ==== ----1111,,,, ccccoooonnnnsssstttt cccchhhhaaaarrrr **** _n_a_m_e====0000 ))))
  31.       QQQQGGGGMMMMaaaannnnaaaaggggeeeerrrr**** bbbbaaaassssiiiiccccMMMMaaaannnnaaaaggggeeeerrrr (((())))
  32.       vvvviiiirrrrttttuuuuaaaallll QQQQCCCChhhhaaaaiiiinnnn**** mmmmaaaaiiiinnnnVVVVeeeerrrrttttiiiiccccaaaallllCCCChhhhaaaaiiiinnnn (((())))
  33.       vvvviiiirrrrttttuuuuaaaallll QQQQCCCChhhhaaaaiiiinnnn**** mmmmaaaaiiiinnnnHHHHoooorrrriiiizzzzoooonnnnttttaaaallllCCCChhhhaaaaiiiinnnn (((())))
  34.       vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd iiiinnnniiiittttGGGGMMMM (((())))
  35.       vvvvooooiiiidddd aaaaddddddddCCCChhhhiiiillllddddLLLLaaaayyyyoooouuuutttt ((((    QQQQLLLLaaaayyyyoooouuuutttt    **** ))))
  36.  
  37.     SSSSttttaaaattttiiiicccc PPPPrrrrooootttteeeecccctttteeeedddd MMMMeeeemmmmbbbbeeeerrrrssss
  38.       QQQQCCCChhhhaaaaiiiinnnn**** vvvveeeerrrrCCCChhhhaaaaiiiinnnn (((( QQQQLLLLaaaayyyyoooouuuutttt **** llll ))))
  39.       QQQQCCCChhhhaaaaiiiinnnn**** hhhhoooorrrrCCCChhhhaaaaiiiinnnn (((( QQQQLLLLaaaayyyyoooouuuutttt **** llll ))))
  40.  
  41.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  42.       The QLayout class is the base    class of geometry specifiers.
  43.  
  44.       This is an abstract base class. The concrete layout managers
  45.       QBoxLayout and QGridLayout inherit from this one and make
  46.       QLayout's functionality avaialble in friendly    APIs.
  47.  
  48.       Most users of    Q*Layout are likely to use some    of the basic
  49.       functions provided by    QLayout, such as
  50.  
  51.      representation and    activates the result,
  52.       activate(), which compiles the layout    into an    internal
  53.  
  54.      the special properties of menu bars, and
  55.       setMenuBar(),    which is necessary to manage a menu bar    because    of
  56.  
  57.      layout.
  58.       freeze(), which allows you to    freeze the widget's size and
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 9/22/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      QQQQLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))      QQQQLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))
  71.  
  72.  
  73.  
  74.       Geometry management stops when the layout manager is
  75.       deleted.
  76.  
  77.       To make a new    layout manager,    you need to implement the
  78.       functions mainVerticalChain(), mainHorizontalChain() and
  79.       initGM().
  80.  
  81.      MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDOOOOCCCCUUUUMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  82.      QQQQLLLLaaaayyyyoooouuuutttt::::::::QQQQLLLLaaaayyyyoooouuuutttt ((((    QQQQWWWWiiiiddddggggeeeetttt    **** ppppaaaarrrreeeennnntttt,,,, iiiinnnntttt bbbboooorrrrddddeeeerrrr,,,, iiiinnnntttt aaaauuuuttttooooBBBBoooorrrrddddeeeerrrr,,,,
  83.       ccccoooonnnnsssstttt    cccchhhhaaaarrrr **** nnnnaaaammmmeeee )))) [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
  84.       Creates a new    top-level QLayout with main widget _p_a_r_e_n_t.
  85.       _p_a_r_e_n_t may not be 0.
  86.  
  87.       _b_o_r_d_e_r is the    number of pixels between the edge of the
  88.       widget and the managed children. _a_u_t_o_B_o_r_d_e_r sets the value
  89.       of defaultBorder(), which is interpreted by subclasses. If
  90.       _a_u_t_o_B_o_r_d_e_r is    -1 the value of    _b_o_r_d_e_r is used.
  91.  
  92.       _n_a_m_e is the internal object name
  93.  
  94.       Having several top-level layouts for the same    widget will
  95.       cause    considerable confusion.
  96.  
  97.      QQQQLLLLaaaayyyyoooouuuutttt::::::::QQQQLLLLaaaayyyyoooouuuutttt ((((    iiiinnnntttt aaaauuuuttttooooBBBBoooorrrrddddeeeerrrr ==== ----1111,,,, ccccoooonnnnsssstttt cccchhhhaaaarrrr    **** nnnnaaaammmmeeee====0000 ))))
  98.       [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
  99.       Constructs a new child QLayout, If _a_u_t_o_B_o_r_d_e_r    is -1, this
  100.       QLayout inherits _p_a_r_e_n_t'_s defaultBorder(), otherwise
  101.       _a_u_t_o_B_o_r_d_e_r is    used.
  102.  
  103.      QQQQLLLLaaaayyyyoooouuuutttt::::::::~~~~QQQQLLLLaaaayyyyoooouuuutttt (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  104.       Deletes all children layouts.    Geometry management stops when
  105.       a toplevel layout is deleted.
  106.  
  107.      bbbboooooooollll QQQQLLLLaaaayyyyoooouuuutttt::::::::aaaaccccttttiiiivvvvaaaatttteeee (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  108.       Starts geometry management - analogous to show() for
  109.       widgets. This    function should    only be    called for top level
  110.       layouts.
  111.  
  112.       Examples:  pref/pref.cpp layout/layout.cpp
  113.       widgets/widgets.cpp
  114.  
  115.      vvvvooooiiiidddd QQQQLLLLaaaayyyyoooouuuutttt::::::::aaaaddddddddCCCChhhhiiiillllddddLLLLaaaayyyyoooouuuutttt (((( QQQQLLLLaaaayyyyoooouuuutttt **** llll    )))) [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
  116.       This function    is called from addLayout functions in
  117.       subclasses, to add _l layout as a sublayout.
  118.  
  119.      QQQQGGGGMMMMaaaannnnaaaaggggeeeerrrr **** QQQQLLLLaaaayyyyoooouuuutttt::::::::bbbbaaaassssiiiiccccMMMMaaaannnnaaaaggggeeeerrrr (((()))) [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
  120.       Returns the QGManager    for this layout. Returns 0 if this is
  121.       a child layout which has not been inserted yet.
  122.  
  123.      iiiinnnntttt QQQQLLLLaaaayyyyoooouuuutttt::::::::ddddeeeeffffaaaauuuullllttttBBBBoooorrrrddddeeeerrrr    (((()))) ccccoooonnnnsssstttt
  124.       Returns the default border for the geometry manager.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                         (printed 9/22/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      QQQQLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))      QQQQLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))
  137.  
  138.  
  139.  
  140.      vvvvooooiiiidddd QQQQLLLLaaaayyyyoooouuuutttt::::::::ffffrrrreeeeeeeezzzzeeee (((( iiiinnnntttt    wwww,,,, iiiinnnntttt hhhh ))))
  141.       Fixes    the size of the    main widget and    distributes the
  142.       available space to the child widgets.    For widgets which
  143.       should not be    resizable, but where a QLayout subclass    is
  144.       used to set up the initial geometry.
  145.  
  146.       A frozen layout cannot be unfrozen, the only sensible    thing
  147.       to do    is to delete it.
  148.  
  149.       The size is adjusted to a valid value. Thus freeze(0,0)
  150.       fixes    the widget to its minimum size.
  151.  
  152.      vvvvooooiiiidddd QQQQLLLLaaaayyyyoooouuuutttt::::::::ffffrrrreeeeeeeezzzzeeee (((())))
  153.       This is an overloaded    member function, provided for
  154.       convenience. It differs from the above function only in what
  155.       argument(s) it accepts.
  156.  
  157.       This version of the method fixes the main widget at its
  158.       minimum size.    You can    also achieve this with freeze( 0, 0
  159.       );.
  160.  
  161.      QQQQCCCChhhhaaaaiiiinnnn **** QQQQLLLLaaaayyyyoooouuuutttt::::::::hhhhoooorrrrCCCChhhhaaaaiiiinnnn    (((( QQQQLLLLaaaayyyyoooouuuutttt **** )))) [[[[ssssttttaaaattttiiiicccc pppprrrrooootttteeeecccctttteeeedddd]]]]
  162.       This function    works around a dubious feature in the C++
  163.       language definition, to provide access to
  164.       mainHorizontalChain().
  165.  
  166.      vvvvooooiiiidddd QQQQLLLLaaaayyyyoooouuuutttt::::::::iiiinnnniiiittttGGGGMMMM (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll pppprrrrooootttteeeecccctttteeeedddd]]]]
  167.       Implement this function to do    what's necessary to initialize
  168.       chains, once the layout has a    basicManager().
  169.  
  170.       Reimplemented    in QGridLayout and QBoxLayout.
  171.  
  172.      QQQQCCCChhhhaaaaiiiinnnn **** QQQQLLLLaaaayyyyoooouuuutttt::::::::mmmmaaaaiiiinnnnHHHHoooorrrriiiizzzzoooonnnnttttaaaallllCCCChhhhaaaaiiiinnnn (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll pppprrrrooootttteeeecccctttteeeedddd]]]]
  173.       Implement this function to return the    main horizontal    chain.
  174.  
  175.       Reimplemented    in QGridLayout and QBoxLayout.
  176.  
  177.      QQQQCCCChhhhaaaaiiiinnnn **** QQQQLLLLaaaayyyyoooouuuutttt::::::::mmmmaaaaiiiinnnnVVVVeeeerrrrttttiiiiccccaaaallllCCCChhhhaaaaiiiinnnn (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll pppprrrrooootttteeeecccctttteeeedddd]]]]
  178.       Implement this function to return the    main vertical chain.
  179.  
  180.       Reimplemented    in QGridLayout and QBoxLayout.
  181.  
  182.      QQQQWWWWiiiiddddggggeeeetttt **** QQQQLLLLaaaayyyyoooouuuutttt::::::::mmmmaaaaiiiinnnnWWWWiiiiddddggggeeeetttt (((())))
  183.       Returns the main widget of this layout, or 0 if this layout
  184.       is a sub-layout which    is not yet inserted.
  185.  
  186.      vvvvooooiiiidddd QQQQLLLLaaaayyyyoooouuuutttt::::::::sssseeeettttMMMMeeeennnnuuuuBBBBaaaarrrr ((((    QQQQMMMMeeeennnnuuuuBBBBaaaarrrr **** wwww ))))
  187.       Makes    the geometry manager take account of the menu bar _w.
  188.       All child widgets are    placed below the bottom    edge of    the
  189.       menu bar.
  190.  
  191.       A menu bar does its own geometry managing, never do
  192.  
  193.  
  194.  
  195.      Page 3                         (printed 9/22/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      QQQQLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))      QQQQLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))
  203.  
  204.  
  205.  
  206.       addWidget() on a menu    bar.
  207.  
  208.       Examples:  widgets/widgets.cpp
  209.  
  210.      QQQQCCCChhhhaaaaiiiinnnn **** QQQQLLLLaaaayyyyoooouuuutttt::::::::vvvveeeerrrrCCCChhhhaaaaiiiinnnn    (((( QQQQLLLLaaaayyyyoooouuuutttt **** )))) [[[[ssssttttaaaattttiiiicccc pppprrrrooootttteeeecccctttteeeedddd]]]]
  211.       This function    works around a dubious feature in the C++
  212.       language definition, to provide access to
  213.       mainVerticalChain().
  214.  
  215.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  216.       hhhhttttttttpppp::::////////wwwwwwwwwwww....ttttrrrroooollllllll....nnnnoooo////qqqqtttt////qqqqllllaaaayyyyoooouuuutttt....hhhhttttmmmmllll
  217.  
  218.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  219.       Copyright 1992-1997 Troll Tech AS.  See the LICENSE file
  220.       included in the distribution for a complete license
  221.       statement.
  222.  
  223.      AAAAUUUUTTTTHHHHOOOORRRR
  224.       Generated automatically from the source code.
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                         (printed 9/22/98)
  262.  
  263.  
  264.  
  265.